מה שאף אחד לא קורא - מה הופך כתיבה טכנית למקצועית 

אם נודה על האמת, רוב האנשים לא אוהבים לקרוא מסמכים טכניים. משתמש ממוצע מן המניין יעדיף לבדוק את המוצר באצבעותיו, בשיטת הניסוי והטעייה, ולא לשבת ולקרוא חוברת הוראות ארוכה ומייגעת בזמן שהמוצר החדש שקנה יושב ארוז ומחכה ל"טקס החניכה". לא לחינם כתבים טכניים רבים מתייחסים למסמכים שהם כותבים כ"מה שאף אחד לא קורא". ככל הנראה זו גם הסיבה לכך שרוב האנשים שלא עוסקים בכתיבה טכנית מעריכים אותה כמשעממת ואפורה.

בדיוק בגלל זה ההתייחסות למסמך טכני מצדו של הכותב אותו צריכה להיות שונה מהתייחסותו למסמכים אחרים אותם הוא כותב. ההנחות העומדות בבסיסה של הכתיבה הטכנית צריכות להיות שהמסמך הטכני הוא המוצא האחרון של המשתמש, לאחר שכל ניסיונותיו לתפעול המוצר או לטיפול בתקלה עלו בתוהו, וכן שהוא מעדיף שהיקף הקריאה במדריך יהיה מצומצם ככל הניתן (אחרי הכל, לא מדובר בספרות מופת). מדריך טוב למשתמש נבחן, אם כן, בקלות שבה הוא מאפשר לקורא לשלוף ממנו מידע (information retrieval) בצורה מהירה, יעילה וקלה. זאת כמובן מעבר לאינדקציות הרגילות למסמך טוב; ניסוח רהוט, קוהרנטיות, זרימה וכו'.

הכלים העיקריים המאפשרים שליפת מידע הם תוכן העניינים והאינדקס, ואין לזלזל בהם. תכנון קפדני ויעיל של המסמך יאפשר בנייה של תוכן עניינים ואינדקס יעילים בצורה מהירה וקלה באמצעות הכלים האוטומטיים של MS Word או של תוכנת עריכה שולחנית (DTP) בה נעשה שימוש. אלה בתורם יעזרו למשתמש למצוא את הפתרון לבעיה בה נתקל באופן המהיר ביותר.

תוכן העניינים משקף את ההיררכיה של המסמך כולו, ולכן כדי לחולל תוכן עניינים מוצלח באופן אוטומטי, כפי שמאפשר MS Word, יש לבנות היררכיה הגיונית למסמך כולו. למעשה בניית היררכיה כזו מראש עוזרת בדברים נוספים. היא למשל מאפשרת לכתב להעריך את אורך המסמך, וכן את היקף העבודה והזמן שתגזול עוד לפני שהושלמה. בנוסף סידור הנושאים בהיררכיה עוזר גם לכותב לעשות סדר בראש, עוד לפני שהמסמך בכלל נכתב.

כתיבת אינדקס היא סיפור שונה לגמרי, ועליו ארחיב בפעם אחרת. רק אומר שלרוב האינדקס נבנה לאחר שהמסמך כבר הושלם, ועוזר לשדרג אותו. MS Word מאפשר ליוצר המסמך לסמן לאורכו ערכים אשר יופיעו באינדקס, ולאחר מכן לחולל את האינדקס באופן אוטומטי. למרות כל זה הפסיכולוגיה שעומדת מאחורי האינדקס, זו שמסייעת בקביעת הערכים המדוייקים לחיפוש וכו', עדיין מנוהלת באופן ידני על ידי יוצר המסמך.

לסיכום אומר שהעובדה שרוב משתמשי המוצר מעדיפים לדלג על חוברת ההדרכה ולגשת ישירות למוצר לא מסירה את האחריות מכותב החוברת לכתיבה טובה, אלא רק משנה מעט את ההגדרה לכתיבה כזו. מסמך טכני טוב לא נמדד באורכו לכאן או לכאן, אלא בכמות האנרגיה שיש להשקיע על מנת להגיע למידע הרצוי באופן מהיר ומדוייק. אם משתמש נבוך, אשר נתקל בבעיה תוך שימוש במוצר, יכול להעזר במדריך למשתמש בכדי להגיע במהירות לפתרון לו זקוק, הרי שאנו ככתובי המסמך עשינו עבודה טובה. משתמש אשר מצא את המדריך יעיל ישוב וישתמש בו אם ייתקל באתגרים נוספים ולרוב ניתנת רק הזדמנות אחת. השקעה בתכנון יעיל וקפדני של אינדקס ותוכן עניינים יתרום רבות לאיכות המסמך כפי שנתפסת על ידי קוראיו.